home *** CD-ROM | disk | FTP | other *** search
/ Creative Computers / Creative Computers CD-ROM, Volume 1 (Legendary Design Technologies, Inc.)(1994).iso / commercial / inovatronics / candodemo / helpfiles / documents  < prev    next >
Text File  |  1994-11-17  |  8KB  |  363 lines
  1. V- CharsToBegOfLine        |charstobegofline|
  2. V- CharsToEndOfLine        |charstoendofline|
  3. C- Clear                |clear|
  4. C- Delete                |delete|
  5. V- DocumentName            |documentname|
  6. C- InsertDocument        |insertdocument|
  7. V- LengthOfLine            |lengthofline|
  8. V- LinesInDocument        |linesindocument|
  9. C- LoadDocument            |loaddocument|
  10. C- MakeDocument            |makedocument|
  11. C- MoveCursor            |movecursor|
  12. C- MoveCursorTo            |movecursorto|
  13. C- NewLine                |newline|
  14. C- PositionOnLine        |positiononline|
  15. C- Replace                |replace|
  16. C- SaveDocument            |savedocument|
  17. C- SearchFor            |searchfor|
  18. V- SearchFound            |searchfound|
  19. C- SetWordDelimiters    |setworddelimiters|
  20. V- SizeOfDocument        |sizeofdocument|
  21. C- SortDocument            |sortdocument|
  22. C- SplitLine            |splitline|
  23. F- TextFromDocument        |textfromdocument|
  24. V- TheCharacter            |thecharacter|
  25. V- TheColumnNumber        |thecolumnnumber|
  26. V- TheLine                |theline|
  27. V- TheLineNumber        |thelinenumber|
  28. V- TheWord                |theword|
  29. V- TheWordDelimiters    |theworddelimiters|
  30. C- Type                    |type|
  31. C- WorkWithDocument        |workwithdocument|
  32. [E]
  33.  
  34. |charstobegofline|
  35. WT {String}=CharsToBegOfLine
  36. PL The characters before the cursor on the
  37. PL current line, but not including the
  38. PL character that the cursor is on.
  39. PL 
  40. PT SEE ALSO: 
  41. BS CharsToEndOfLine
  42. PT .
  43. ED
  44.  
  45. |charstoendofline|
  46. WT {String}=CharsToEndOfLine
  47. PL The characters after the cursor on the
  48. PL current line, but not including the
  49. PL character that the cursor is on.
  50. PL 
  51. PT SEE ALSO: 
  52. BS CharsToBegOfLine
  53. PT .
  54. ED
  55.  
  56. |clear|
  57. WT Clear <flags>
  58. PL If the flag is DOCUMENT then this command
  59. PL will clear out the whole document where as
  60. PL if the flag is LINE it will clear only the
  61. PL current line.
  62. PL
  63. PT SEE ALSO: 
  64. BS Delete
  65. PT .
  66. ED
  67.  
  68. |delete|
  69. WT Delete <flags> [,{Count}]
  70. PL This command will delete parts of your
  71. PL current document.  The flags include:
  72. PL The flags include CHARACTER, CHARACTERS,
  73. PL LINE, TOSTARTOFLINE and TOENDOFLINE.
  74. PL See the manual for a full description
  75. PL of this command.
  76. ED
  77.  
  78. |documentname|
  79. WT {DocumentBufferName}=DocumentName
  80. PL This returns the buffer name of the
  81. PL current document.
  82. PL
  83. PT SEE ALSO: 
  84. BS WorkWithDocument
  85. PT .
  86. ED
  87.  
  88. |insertdocument|
  89. WT InsertDocument {SourceDocumentName} [,{StartingLine} [,{LineCount}]]
  90. PL Inserts text from the specified document
  91. PL into the current document at the current
  92. PL cursor position.  Optionally, a start line
  93. PL and the number of lines to copy can be
  94. PL specified.
  95. PT SEE ALSO: 
  96. BS Type
  97. PT .
  98. ED
  99.  
  100. |lengthofline|
  101. WT {Integer}=LengthOfLine
  102. PL This returns the number of characters
  103. PL in the current document line.
  104. ED
  105.  
  106. |linesindocument|
  107. WT {Integer}=LinesInDocument
  108. PL This returns the number of lines
  109. PL in the current document.
  110. ED
  111.  
  112. |loaddocument|
  113. WT LoadDocument {FilePath} [,{DocumentBufferName} [,<loadflags>]]
  114. Pl Preload a document, either FTXT or ASCII.
  115. PL See the manual for a full description
  116. PL of this command.
  117. PL
  118. PT SEE ALSO: 
  119. BS SaveDocument
  120. PT .
  121. ED
  122.  
  123. |makedocument|
  124. WT MakeDocument {DocumentBufferName}
  125. PL This command makes an empty document
  126. PL buffer with the name specified.
  127. PL
  128. PT SEE ALSO: 
  129. BS WorkWithDocument
  130. PT .
  131. ED
  132.  
  133. |movecursor|
  134. WT MoveCursor <directionflags> [,{Count}]
  135. PL Moves the cursor, in the given direction,
  136. PL in the document.  The direction flags are
  137. PL UP, DOWN, LEFT and RIGHT.  You may also
  138. PL specify the number of times to move.
  139. PL
  140. PT SEE ALSO: 
  141. BS MoveCursorTo
  142. PT .
  143. ED
  144.  
  145. |movecursorto|
  146. WT MoveCursorTo <flags> [,{Count}]
  147. PL Moves the cursor around in the document.
  148. PL Flags include: STARTOF and ENDOF modifiers
  149. PL and DOCUMENT, LINE, NEXTWORD, THISWORD and
  150. PL PREVIOUSWORD which specify the scope of the
  151. PL movement.  You may also specify the number
  152. PT times to move.  SEE ALSO: 
  153. BS MoveCursor
  154. PT .
  155. ED
  156.  
  157. |newline|
  158. WT NewLine
  159. PL Has the same effect as moving to the end of
  160. PL the current line and hitting the RETURN key.
  161. PL
  162. PT SEE ALSO: 
  163. BS SplitLine
  164. PT .
  165. ED
  166.  
  167. |positiononline|
  168. WT PositionOnLine {LineNumber}
  169. PL Move the cursor to the specified line.
  170. PL
  171. PT SEE ALSO: 
  172. BS TheLineNumber
  173. PT .
  174. ED
  175.  
  176. |replace|
  177. WT Replace {SearchString}, {ReplaceString} [,<flags>]
  178. PL Does a search and replace in the current
  179. PL document using the given strings.  See
  180. PL the manual for a full description of
  181. PL this command.
  182. PL
  183. PT SEE ALSO: 
  184. BS SearchFor
  185. PT  and 
  186. BS SearchFound
  187. PT .
  188. ED
  189.  
  190. |savedocument|
  191. WT SaveDocument {DocumentBufferName} [,{FilePath} [,<flags>]]
  192. PL Saves the specified document to either its
  193. PL default, original, filepath or to the given
  194. PL filepath.  Optionally you may specify the
  195. PL way to save the document, either FTXT
  196. PL or ASCII.
  197. PT SEE ALSO: 
  198. BS LoadDocument
  199. PT .
  200. ED
  201.  
  202. |searchfor|
  203. WT SearchFor {SearchString} [,<flags>]
  204. PL This command searches the current document
  205. PL for the specified string.  See the manual
  206. PL for a full description of this command.
  207. PL
  208. PT SEE ALSO: 
  209. BS Replace
  210. PT  and 
  211. BS SearchFound
  212. PT .
  213. ED
  214.  
  215. |searchfound|
  216. WT {Logical}=SearchFound
  217. PL This variable has many uses and is set by
  218. PL many commands and functions.  The document
  219. PT commands 
  220. BS SearchFor
  221. PT  and 
  222. BS Replace
  223. PL  will set this
  224. PL variable to true if they succeed in finding
  225. PL their search strings.  Also the database
  226. PT system's functions: 
  227. BS SearchArray
  228. PT ,   (more...)
  229. NP searchfound2
  230. ED
  231.  
  232. |searchfound2|
  233. BS NextArrayIndex
  234. PT , 
  235. BS PreviousArrayIndex
  236. PL ,
  237. BS FirstArrayIndex
  238. PT  and 
  239. BS LastArrayIndex
  240. PL 
  241. PL will set the SearchFound variable if they
  242. PL succeed.
  243. PP searchfound
  244. ED
  245.  
  246. |setworddelimiters|
  247. WT SetWordDelimiters {WordDelimiters}
  248. PL This defines the current document's word
  249. PL delimiter character set.  This may change
  250. PL the results of many document commands,
  251. PL functions and variables.
  252. PL
  253. PT SEE ALSO: 
  254. BS TheWordDelimiters
  255. PT  and 
  256. BS TheWord
  257. PT .
  258. ED
  259.  
  260. |sizeofdocument|
  261. WT {Integer}=SizeOfDocument
  262. PL This returns the size in characters of the
  263. PL current document.
  264. ED
  265.  
  266. |sortdocument|
  267. WT SortDocument <flags> [,{StartingColumn}]
  268. PL This command sorts the current document.
  269. PL See the manual for a full description
  270. PL of this command.
  271. ED
  272.  
  273. |splitline|
  274. WT SplitLine [{Count}]
  275. PL Has the same effect as a RETURN key in the
  276. PL current document.  You may also specify the
  277. PL number of times to do this.
  278. PL
  279. PT SEE ALSO: 
  280. BS NewLine
  281. PT .
  282. ED
  283.  
  284. |textfromdocument|
  285. WT {String}=TextFromDocument(DocumentName)
  286. PL This returns the contents of a document
  287. PL as a single, sometimes large, text string.
  288. PL See the manual for a full description
  289. PL of this function.
  290. ED
  291.  
  292. |thecharacter|
  293. WT {String}=TheCharacter
  294. PL This returns the character that the document
  295. PL cursor is on.  If the cursor is at the end
  296. PT of the document then a 
  297. BS Nothing
  298. PT  is returned.
  299. ED
  300.  
  301. |thecolumnnumber|
  302. WT {Integer}=TheColumnNumber
  303. PL This returns the current column number in
  304. PL the document that the cursor is on.
  305. ED
  306.  
  307. |theline|
  308. WT {String}=TheLine
  309. PL This returns the line that the document
  310. PL cursor is on.  If the cursor is on an empty
  311. PT line then a 
  312. BS Nothing
  313. PT  is returned.
  314. ED
  315.  
  316. |thelinenumber|
  317. WT {Integer}=TheLineNumber
  318. PL This returns the current line number in
  319. PL the document that the cursor is on.
  320. ED
  321.  
  322. |theword|
  323. WT {String}=TheWord
  324. PL This returns the word that the document
  325. PL cursor is on.  If the cursor is on an empty
  326. PT line then a 
  327. BS Nothing
  328. PL  is returned.
  329. PL Remember that what this variable returns
  330. PT depends on how 
  331. BS TheWordDelimiters
  332. PL  is set up.
  333. ED
  334.  
  335. |theworddelimiters|
  336. WT {String}=TheWordDelimiters
  337. PL This returns the current document's word
  338. PL delimiters character set.
  339. PL
  340. PT SEE ALSO: 
  341. BS SetWordDelimiters
  342. PT .
  343. ED
  344.  
  345. |type|
  346. WT Type {String} [,<flag>]
  347. PL This command types the given string into
  348. PL the current document.  If the NEWLINE flag
  349. PL is given the a RETURN is typed at the end
  350. PL of the string.
  351. ED
  352.  
  353. |workwithdocument|
  354. WT WorkWithDocument {DocumentBufferName}
  355. PL All subsequent document commands, functions
  356. PL and variables will use the specified
  357. PL as their current document.
  358. PL
  359. PT SEE ALSO: 
  360. BS MakeDocument
  361. PT .
  362. ED
  363.